/*
 * Copyright 2007-2008 Brian Cavalier
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package  org.bc.iterate;

import java.util.regex.Pattern;

/**
 * OGrep is a {@link org.bc.iterate.Test} that matches regular expressions.  In addition to matching
 * against {@code Strings}, it can also match against {@code Objects} by calling {@code toString()}
 * on them.
 *
 * @author Brian Cavalier
 * @see Test
 */
public class GrepObject implements Test<Object>{
	private Pattern pattern;

	/**
	 * Construct an OGrep that uses the supplied {@link java.util.regex.Pattern} for matching.
	 *
	 * @param p {@link java.util.regex.Pattern} to use in matching.
	 */
	public GrepObject(Pattern p) {
		pattern = p;
	}


	/**
	 * Invokes {@code toString()} on the {@code Object} and performs a pattern match against
	 * the resulting {@code String}.
	 *
	 * @param item {@code Object} on which to call {@code toString()} then perform a pattern
	 * match
	 * @return true if resulting {@code String} matches the {@link Pattern}.
	 */
	public boolean go(Object item) {
		return(pattern.matcher(item.toString()).matches());
	}
}
